// Copyright 2016 The PDFium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com

#ifndef CORE_FPDFAPI_PARSER_CPDF_LINEARIZED_HEADER_H_
#define CORE_FPDFAPI_PARSER_CPDF_LINEARIZED_HEADER_H_

#include <stdint.h>

#include <memory>

#include "core/fxcrt/fx_types.h"

class CPDF_Dictionary;
class CPDF_SyntaxParser;

class CPDF_LinearizedHeader {
 public:
  ~CPDF_LinearizedHeader();
  static std::unique_ptr<CPDF_LinearizedHeader> Parse(
      CPDF_SyntaxParser* parser);

  // Will only return values > 0.
  FX_FILESIZE GetFileSize() const { return m_szFileSize; }
  uint32_t GetFirstPageNo() const { return m_dwFirstPageNo; }
  // Will only return values > 0.
  FX_FILESIZE GetMainXRefTableFirstEntryOffset() const {
    return m_szMainXRefTableFirstEntryOffset;
  }
  uint32_t GetPageCount() const { return m_PageCount; }
  // Will only return values > 0.
  FX_FILESIZE GetFirstPageEndOffset() const { return m_szFirstPageEndOffset; }
  // Will only return values in the range [1, `CPDF_Parser::kMaxObjectNumber`).
  uint32_t GetFirstPageObjNum() const { return m_FirstPageObjNum; }
  // Will only return values > 0.
  FX_FILESIZE GetLastXRefOffset() const { return m_szLastXRefOffset; }

  bool HasHintTable() const;
  // Will only return values > 0.
  FX_FILESIZE GetHintStart() const { return m_szHintStart; }
  uint32_t GetHintLength() const { return m_HintLength; }

 protected:
  CPDF_LinearizedHeader(const CPDF_Dictionary* pDict,
                        FX_FILESIZE szLastXRefOffset);

 private:
  const FX_FILESIZE m_szFileSize;
  const uint32_t m_dwFirstPageNo;
  const FX_FILESIZE m_szMainXRefTableFirstEntryOffset;
  const uint32_t m_PageCount;
  const FX_FILESIZE m_szFirstPageEndOffset;
  const uint32_t m_FirstPageObjNum;
  const FX_FILESIZE m_szLastXRefOffset;
  FX_FILESIZE m_szHintStart = 0;
  uint32_t m_HintLength = 0;
};

#endif  // CORE_FPDFAPI_PARSER_CPDF_LINEARIZED_HEADER_H_


`CPDF_LinearizedHeader` 类提供了处理 PDF 线性化头部信息的功能。以下是该接口的功能列表：

### CPDF_LinearizedHeader 类

#### 公共方法
1. * *~CPDF_LinearizedHeader() * *: 析构函数，用于销毁线性化头部对象。
2. * *static std::unique_ptr<CPDF_LinearizedHeader> Parse(CPDF_SyntaxParser * parser) * *: 静态方法，用于解析 PDF 语法并返回一个 `CPDF_LinearizedHeader` 对象的智能指针。

3. * *FX_FILESIZE GetFileSize() const** : 获取文件的总大小（仅返回大于 0 的值）。
4. * *uint32_t GetFirstPageNo() const** : 获取文件中第一页的页码。
5. * *FX_FILESIZE GetMainXRefTableFirstEntryOffset() const** : 获取主交叉引用表的第一个条目的偏移量（仅返回大于 0 的值）。
6. * *uint32_t GetPageCount() const** : 获取文档的总页数。
7. * *FX_FILESIZE GetFirstPageEndOffset() const** : 获取第一页结尾的偏移量（仅返回大于 0 的值）。
8. * *uint32_t GetFirstPageObjNum() const** : 获取第一页对象的编号（返回值范围在 1 到 `CPDF_Parser: : kMaxObjectNumber` 之间）。
9. * *FX_FILESIZE GetLastXRefOffset() const** : 获取最后一个交叉引用的偏移量（仅返回大于 0 的值）。

10. * *bool HasHintTable() const** : 检查是否存在提示表。
11. * *FX_FILESIZE GetHintStart() const** : 获取提示表的起始偏移量（仅返回大于 0 的值）。
12. * *uint32_t GetHintLength() const** : 获取提示表的长度。

#### 受保护方法
13. * *CPDF_LinearizedHeader(const CPDF_Dictionary * pDict, FX_FILESIZE szLastXRefOffset) * *: 构造函数，用于初始化线性化头部对象。

这些方法用于管理和访问 PDF 文件线性化信息，包括文件大小、第一页信息、交叉引用表以及提示表等。这对于优化 PDF 文件的加载和浏览性能是非常重要的。